home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / g_man / cat3 / OpenGL / glgeterror.z / glgeterror
Encoding:
Text File  |  1998-10-20  |  8.4 KB  |  133 lines
  1.  
  2.  
  3.  
  4. ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr((((3333GGGG))))                 OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee                 ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr((((3333GGGG))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr - return error information
  10.  
  11.  
  12. CCCC SSSSPPPPEEEECCCCIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  13.      GLenum ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr( void )
  14.  
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr returns the value of the error flag.  Each detectable error is
  18.      assigned a numeric code and symbolic name.  When an error occurs, the
  19.      error flag is set to the appropriate error code value.  No other errors
  20.      are recorded until ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr is called, the error code is returned, and
  21.      the flag is reset to GGGGLLLL____NNNNOOOO____EEEERRRRRRRROOOORRRR.  If a call to ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr returns
  22.      GGGGLLLL____NNNNOOOO____EEEERRRRRRRROOOORRRR, there has been no detectable error since the last call to
  23.      ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr, or since the GL was initialized.
  24.  
  25.      To allow for distributed implementations, there may be several error
  26.      flags.  If any single error flag has recorded an error, the value of that
  27.      flag is returned and that flag is reset to GGGGLLLL____NNNNOOOO____EEEERRRRRRRROOOORRRR when ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr is
  28.      called.  If more than one flag has recorded an error, ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr returns
  29.      and clears an arbitrary error flag value.  Thus, ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr should always
  30.      be called in a loop, until it returns GGGGLLLL____NNNNOOOO____EEEERRRRRRRROOOORRRR, if all error flags are
  31.      to be reset.
  32.  
  33.      Initially, all error flags are set to GGGGLLLL____NNNNOOOO____EEEERRRRRRRROOOORRRR.
  34.  
  35.      The following errors are currently defined:
  36.  
  37.      GGGGLLLL____NNNNOOOO____EEEERRRRRRRROOOORRRR                   No error has been recorded.  The value of
  38.                                    this symbolic constant is guaranteed to be
  39.                                    0.
  40.  
  41.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEENNNNUUUUMMMM               An unacceptable value is specified for an
  42.                                    enumerated argument.  The offending command
  43.                                    is ignored, and has no other side effect
  44.                                    than to set the error flag.
  45.  
  46.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____VVVVAAAALLLLUUUUEEEE              A numeric argument is out of range.  The
  47.                                    offending command is ignored, and has no
  48.                                    other side effect than to set the error
  49.                                    flag. This flag is also set when the
  50.                                    implementation cannot accomodate an image
  51.                                    of the size requested by ggggllllTTTTeeeexxxxIIIImmmmaaaaggggeeee3333DDDDEEEExxxxtttt,
  52.                                    ggggllllTTTTeeeexxxxIIIImmmmaaaaggggeeee2222DDDD, or ggggllllTTTTeeeexxxxIIIImmmmaaaaggggeeee1111DDDD.  The error
  53.                                    is  not generated for a
  54.                                    GGGGLLLL____PPPPRRRROOOOXXXXYYYY____TTTTEEEEXXXXTTTTUUUURRRREEEE____3333DDDD____EEEEXXXXTTTT, a
  55.                                    GGGGLLLL____PPPPRRRROOOOXXXXYYYY____TTTTEEEEXXXXTTTTUUUURRRREEEE____2222DDDD____EEEEXXXXTTTT, or a
  56.                                    GGGGLLLL____PPPPRRRROOOOXXXXYYYY____TTTTEEEEXXXXTTTTUUUURRRREEEE____1111DDDD____EEEEXXXXTTTT.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr((((3333GGGG))))                 OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee                 ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr((((3333GGGG))))
  71.  
  72.  
  73.  
  74.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN          The specified operation is not allowed in
  75.                                    the current state.  The offending command
  76.                                    is ignored, and has no other side effect
  77.                                    than to set the error flag.
  78.  
  79.      GGGGLLLL____SSSSTTTTAAAACCCCKKKK____OOOOVVVVEEEERRRRFFFFLLLLOOOOWWWW             This command would cause a stack overflow.
  80.                                    The offending command is ignored, and has
  81.                                    no other side effect than to set the error
  82.                                    flag.
  83.  
  84.      GGGGLLLL____SSSSTTTTAAAACCCCKKKK____UUUUNNNNDDDDEEEERRRRFFFFLLLLOOOOWWWW            This command would cause a stack underflow.
  85.                                    The offending command is ignored, and has
  86.                                    no other side effect than to set the error
  87.                                    flag.
  88.  
  89.      GGGGLLLL____OOOOUUUUTTTT____OOOOFFFF____MMMMEEEEMMMMOOOORRRRYYYY              There is not enough memory left to execute
  90.                                    the command.  The state of the GL is
  91.                                    undefined, except for the state of the
  92.                                    error flags, after this error is recorded.
  93.  
  94.      GGGGLLLL____TTTTAAAABBBBLLLLEEEE____TTTTOOOOOOOO____LLLLAAAARRRRGGGGEEEE____EEEEXXXXTTTT        The implementation cannot accomodate a
  95.                                    table of the size requested by
  96.                                    ggggllllHHHHiiiissssttttooooggggrrrraaaammmmEEEEXXXXTTTT.  The error is not generated
  97.                                    for GGGGLLLL____PPPPRRRROOOOXXXXYYYY____HHHHIIIISSSSTTTTOOOOGGGGRRRRAAAAMMMM____EEEEXXXXTTTT.
  98.  
  99.      When an error flag is set, results of a GL operation are undefined only
  100.      if GGGGLLLL____OOOOUUUUTTTT____OOOOFFFF____MMMMEEEEMMMMOOOORRRRYYYY has occurred.  In all other cases, the command
  101.      generating the error is ignored and has no effect on the GL state or
  102.      frame buffer contents.  If the generating command returns a value, it
  103.      returns 0. If ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr itself generates an error, it returns 0.
  104.  
  105. EEEERRRRRRRROOOORRRRSSSS
  106.      GGGGLLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD____OOOOPPPPEEEERRRRAAAATTTTIIIIOOOONNNN is generated if ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr is executed between the
  107.      execution of ggggllllBBBBeeeeggggiiiinnnn and the corresponding execution of ggggllllEEEEnnnndddd.  In this
  108.      case ggggllllGGGGeeeettttEEEErrrrrrrroooorrrr returns 0.
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.